home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 007a / hc2.zip / HC.HLP < prev   
Text File  |  1991-09-10  |  5KB  |  72 lines
  1. ╔════════════════════════════════════════════════════════════════════╗
  2. ║                            HelpCOM Help                            ║
  3. ║                                                                    ║
  4. ║ HelpCOM is a utility for adding embedded command-line help to COM  ║
  5. ║ format program files.  This help information is displayed when a ? ║
  6. ║ or /? appears after the name of the COM file on the command-line.  ║
  7. ║                                                                    ║
  8. ║ The syntax of the HC command-line is:                              ║
  9. ║                                                                    ║
  10. ║                    HC [-d] filespec [helpspec]                     ║
  11. ║                                                                    ║
  12. ║ Filespec is the name of the COM program file to be modified.  Path ║
  13. ║ and drive information may be included.  You do not need to specify ║
  14. ║ a file extension but COM must be this extension if specified.  The ║
  15. ║ size of the COM file must not exceed 32K.                          ║
  16. ║                                                                    ║
  17. ║ Helpspec is the name of the HLP file containing ASCII text which   ║
  18. ║ will be inserted into the COM program file.  The size of this file ║
  19. ║ is limited to a maximum of 80 columns by 150 lines and the minimum ║
  20. ║ size is eight characters.  Path and drive information may also be  ║
  21. ║ included.  The extension must be HLP if specified.                 ║
  22. ║                                                                    ║
  23. ║ Helpspec is optional.  If it is not provided then HC expects to    ║
  24. ║ find a file in the current directory with the same name as the COM ║
  25. ║ program file but having an HLP extension.                          ║
  26. ║                                                                    ║
  27. ║ The "-d" or "-D" option will cause HC to delete embedded help info ║
  28. ║ and restore filespec to its original state including file contents ║
  29. ║ and size, and date/time stamps.                                    ║
  30. ║                                                                    ║
  31. ║ You cannot use a dollar-sign character in your help text because   ║
  32. ║ this character is used to indicate the end of a string by function ║
  33. ║ 9 of interrupt 21 hex (which sends a string to standard output and ║
  34. ║ is used in displaying the help text).                              ║
  35. ║                                                                    ║
  36. ║ HC does not come with built-in help.  The file which you are cur-  ║
  37. ║ rently reading contains this help.  You can install this help into ║
  38. ║ HC by typing either "HC" or "HC HC".  You can view this help by    ║
  39. ║ typing "HC ?" or "HC /?".                                          ║
  40. ║                                                                    ║
  41. ║ HC requires DOS 2.1 or higher.  Extensive error checking is per-   ║
  42. ║ formed while modifying a COM file.  If an error should occur then  ║
  43. ║ a suitable error message is displayed along with a strange number. ║
  44. ║ This number has no meaning to you but I use it for locating the    ║
  45. ║ code in the source file which generated the error.  You can ignore ║
  46. ║ this number.                                                       ║
  47. ║                                                                    ║
  48. ║ HelpCOM was developed as a simple utility for adding command-line  ║
  49. ║ help to your own COM program files.  You should not modify any COM ║
  50. ║ files which are not your own (for legal reasons).  If you go ahead ║
  51. ║ and modify such files then you assume full responsibility.  Also,  ║
  52. ║ certain COM files such as COMMAND.COM are monitored by anti-virus  ║
  53. ║ programs.  If you use an anti-virus program and it detects changes ║
  54. ║ to COMMAND.COM or any other COM program that it is monitoring then ║
  55. ║ it will probably complain.  Fortunately, HC provides an option of  ║
  56. ║ easily restoring the COM file to its original state.  I would like ║
  57. ║ to stress that HC is different from a virus program.  Although it  ║
  58. ║ also modifies COM files, it does so in a beneficial way and allows ║
  59. ║ you to remove these changes at your convenience.                   ║
  60. ║                                                                    ║
  61. ║ If you have enjoyed using HelpCOM then please register your copy.  ║
  62. ║ The registration fee is 20 dollars and, in return, I will send you ║
  63. ║ a copy of HelpEXE which is functionally identical to HelpCOM but   ║
  64. ║ works with EXE files instead of COM files.  Please specify your    ║
  65. ║ disk size (5-1/4 inch or 3-1/2 inch) when registering.  My address ║
  66. ║ is:                                                                ║
  67. ║                                                                    ║
  68. ║                          Geoff Friesen                             ║
  69. ║                          General Delivery                          ║
  70. ║                          Dauphin, Manitoba                         ║
  71. ║                          Canada R7N 2T3                            ║
  72. ╚════════════════════════════════════════════════════════════════════╝